[]
        
在线Demo 免费试用
(Showing Draft Content)

Shared-Resources

Shared-Resources

[POST] /api/v2/shared-resources/language-resources/import-by-excel

通过Excel导入语言资源

参数:

名称 类型 位置
docId string query

返回值

状态码: 200

成功

ImportLanguageResourceModel

状态码: 400

错误的请求

SharedResourcePluginError

[GET] /api/v2/shared-resources/language-resources

根据指定条件检索语言资源信息。

参数:

名称 类型 位置 描述
docId string query 用于筛选语言资源的文档 ID。如果指定,则仅返回与此文档相关的资源。可选。例如:“doc123”
lngs string query 以逗号分隔的语言列表,用于筛选结果。如果指定,则仅返回这些语言的资源。可选。例如:“en,fr,es”
keys string query 以逗号分隔的键列表,用于筛选语言值。如果指定,则仅返回这些键对应的语言值。可选。例如:“key1,key2,key3”
organizationId string query 当当前用户是系统管理员且此参数有值时,查询将基于指定组织的权限,而不是系统管理员的权限。

返回值

状态码: 200

成功

LanguageVo

状态码: 400

错误的请求

SharedResourcePluginError

[GET] /api/v2/shared-resources/web-pages/{id}

通过网页标识符查询特定网页的信息。

参数:

名称 类型 位置 描述
id必填项 string path 网页的唯一标识符,通常是一个 GUID。例如:123e4567-e89b-12d3-a456-426614174000

返回值

状态码: 200

成功

QueryWebPageInfoResponseModel

状态码: 400

错误的请求

SharedResourcePluginError

状态码: 404

未找到

SharedResourcePluginError

[PUT] /api/v2/shared-resources/web-pages/{id}

更新系统中已有的网页。

参数:

名称 类型 位置 描述
id必填项 string path 要更新的网页的唯一标识符。

请求数据格式

UpdateWebPageRequestModel

返回值

状态码: 204

无内容

状态码: 400

错误的请求

SharedResourcePluginError

状态码: 404

未找到

SharedResourcePluginError

[POST] /api/v2/shared-resources/web-pages

向系统中添加一个新的网页。

请求数据格式

AddWebPageRequestModel

返回值

状态码: 200

成功

AddWebPageResponseModel

状态码: 400

错误的请求

SharedResourcePluginError

类型定义

Ƭ ImportLanguageResourceModel

导入语言资源响应模型

名称 类型 描述 示例
id可为空 string 新语言资源文档 ID

Ƭ SharedResourcePluginError

名称 类型 描述 示例
code可为空 string 错误代码
message可为空 string 错误信息
context可为空 string 错误上下文
innerError SharedResourcePluginError

Ƭ LanguageVo

表示语言信息的集合,包含多种语言的详细信息。

名称 类型 描述 示例
languagesInfo可为空 LanguageInfo 语言信息列表,每条记录包含有关特定语言的详细信息。

Ƭ LanguageInfo

表示有关特定语言的详细信息,包括其标识符和相关的语言记录。

名称 类型 描述 示例
id可为空 string 语言的唯一标识符。
languageRecords可为空 LanguageRecordInfo 此语言关联的语言记录列表。每条记录包含特定键的本地化文本。

Ƭ LanguageRecordInfo

表示单个语言记录,封装名称及其关联的值列表。 此模型用于存储和表示语言中特定键的本地化文本值。

名称 类型 描述 示例
name可为空 string 语言记录的名称或键。它用作本地化文本条目的标识符。
values可为空 LanguageValueViewModel 此语言记录关联的本地化文本值列表。列表中的每个条目代表特定语言的本地化值,由语言代码标识。

Ƭ LanguageValueViewModel

表示语言值的视图模型。该模型用于封装特定语言字符串的键值对表示,以便在 UI 组件中轻松显示和操作。

名称 类型 描述 示例
key可为空 string 获取语​​言值的键。此键通常用作本地化上下文中特定字符串的标识符。
value可为空 string 获取与键关联的本地化字符串值。此值是将在用户界面中显示的实际文本。

Ƭ QueryWebPageInfoResponseModel

表示检索网页信息的查询操作的响应模型。

名称 类型 描述 示例
id可为空 string 网页的唯一标识符。
title可为空 string 网页标题。
url可为空 string 网页的网址。

Ƭ UpdateWebPageRequestModel

名称 类型 描述 示例
comments可为空 string
url可为空 string

Ƭ AddWebPageResponseModel

表示网页添加操作的响应模型。

名称 类型 描述 示例
documentId可为空 string 已添加网页文档的唯一标识符。

Ƭ AddWebPageRequestModel

名称 类型 描述 示例
name可为空 string
url可为空 string
tagIds可为空 Array<string>
comments可为空 string